Purpose: This topic describes the required setup to integrate Order Management System with Order Broker, and how to load item and inventory information from Order Management System into the Order Broker database.
Default system? When you begin setting up data in Order Broker, you build a location group of integrated systems, such as your Order Management System company and your POS system. If your Order Management System company is the default system, or system of record, in Order Broker, then when you import your Order Management System item and SKU records into Order Broker, they serve as the master products, and the product records imported from other systems reference the Order Management System items and SKUs. The Order Management System item and SKU code is the product code in Order Broker, and the product codes from other integrated systems are system products that reference the product code from the default system.
If Order Management System is not the default system in Order Broker, then each item and SKU sent to Order Broker in the product feed needs to reference the product code from the default system. If the systems use different product codes, you can use a secondary field in Order Management System, such as the Reference number or a UPC code, to store the Order Broker product code, so that the Order Management System system product is correctly linked to the default system’s product code during the import process. The OROB Product Code ID (K66) system control value indicates whether the Order Management System item and SKU, or some other field, contains the default system’s product code.
For more information: See:
• background on integration between Order Broker and Order Management System: the Order Broker Integration Overview
• details on the order types, processing, and messages: Order Broker Integration
• instructions on setting up data in Order Broker: the Setting Up Data for the Order Broker Module topic in the Order Broker online help
• instructions on setup required for integration with Order Broker’s Supplier Direct Fulfillment module: Interface with Order Broker’s Supplier Direct Fulfillment Module: Overview and Setup
Version compatibility: Fulfillment assignment and ship-for-pickup functionality is available in release 16.0 or higher of Order Management System and release 16.0 or higher of Order Broker. In order to use ship-for-pickup processing, you must select the Enable Ship For Pickup option on the Organization window in Order Broker. Once you enable ship for pickup, the Ship for Pickup Enabled Date displays on the Organization window and you cannot unselect this option.
In this chapter:
• Order Broker-Related System Control Values
- Setting the Daily Status Inquiry Time Window (all versions)
• Additional Order Broker Setup in Order Management System
• Notes on Configuration in Order Broker
Order Broker-Related System Control Values
Most of the system control values related to integration with Order Broker’s Order Broker are available through the Order Broker Values (K15) umbrella screen. See that screen for more information.
Special orders system control values: The following system control values are required to process special ship-for-pickup orders:
• Order Type for Special Orders (L15): Identifies the order type code that indicates to send the e-commerce order number, rather than the Order Management System order number, as the order ID when submitting the ship-for-pickup order to the Order Broker. Since special ship-for-pickup orders originate in the retail location, they are identified primarily by the store system’s original order number.
• Pay Type for Special Orders (L16): Identifies the pay type that indicates that the customer needs to pay for a ship-for-pickup order when picking it up at the retail location. When a ship-for-pickup order uses this pay type, the Submit Order message indicates a balance_due that is the same as the order total.
• Store Pickup Confirmation Email Program (L48): Use this system control value to specify the program that generates a notification to the customer when a store pickup order is ready for pickup.
Additional system control values:
• To avoid an error in order entry, do not set the Default Previous Pay Type in Order Entry (D64) system control value to ALL; otherwise, the Order Broker Payment Type (K98) might default in order entry, although this pay type is reserved for delivery or retail pickup orders created through integration with the Order Broker.
• Use OROB Status Inquiry List Web Service (M05): Select this system control value to have pick slip generation use the status list request message rather than individual status inquiry request messages to check on whether retail pickup or delivery orders have been canceled by the originating system.
Overview: Use Working with Customer Properties (PROP) to define property settings for:
• Setting the Daily Status Inquiry Time Window (all versions)
Use Working with Admin Properties (CPRP) to define additional settings for:
Purchasing services properties: See Interface with Order Broker’s Supplier Direct Fulfillment Module: Overview and Setup for information on the additional properties related to integration with Order Broker’s Supplier Direct Fulfillment module.
Use the OROB_DISCOVERY_SERVICES_WSDL_LOCATION entry in Working with Customer Properties (PROP) to specify the endpoint for the Discovery Services web service. This entry should be set to https://SERVER:8443/Locate/DiscoveryServices, where SERVER is the name of your Oracle Retail Order Broker server.
Web service authentication: If the web service requires basic web service authentication, you must define a valid web service authentication user and password in Working with Web Service Authentication (WWSA).
For more information: See Importing Store Cross Reference Locations through Order Broker’s Discovery Web Service.
Services WSDL
Use the OROB_SERVICES_WSDL_LOCATION property in Working with Customer Properties (PROP) to specify the endpoint for the Services web service. This entry should be set to https://SERVER:8443/Locate/LocateServices, where SERVER is the name of your Oracle Retail Order Broker server.
Required for Supplier Direct Fulfillment integration: You need to set this property as described above even if you integrate with Order Broker’s Supplier Direct Fulfillment module but not with Order Broker’s Order Broker module, or if you integrate with an earlier version of Order Broker for the Order Broker than you use for the Supplier Direct Fulfillment module.
Web service authentication: If the web service requires basic web service authentication, you must define a valid web service authentication user and password in Working with Web Service Authentication (WWSA).
Purchasing Services WSDL
Use the OROB_PURCHASING_SERVICES_WSDL_LOCATION property in Working with Customer Properties (PROP) to specify the endpoint for the Purchasing Services web service. This entry should be set to https://SERVER:8443/Locate/PurchasingServices, where SERVER is the name of your Oracle Retail Order Broker server.
Required for Supplier Direct Fulfillment integration: You need to set this property as described above even if you integrate with Order Broker’s Supplier Direct Fulfillment module but not with Order Broker’s Order Broker module, or if you integrate with an earlier version of Order Broker for the Order Broker than you use for the Supplier Direct Fulfillment module.
Web service authentication: If the web service requires basic web service authentication, you must define a valid web service authentication user and password in Working with Web Service Authentication (WWSA).
Setting the Daily Status Inquiry Time Window (all versions)
For certain Order Broker statuses, it is not necessary to send a status inquiry as frequently as the Order Broker Status Update Interval (K10), because no immediate action is required in Order Management System.
The following statuses are updated once a day:
Status |
Applies to Order Type |
Description |
In Transit In Transit Polled |
• retail pickup • ship-for pickup if the Use OROB for Ship for Pickup Fulfillment Assignment (M34) system control value is set to NEVER or blank |
You have confirmed shipment of the order from an Order Management System warehouse to the store. |
Received by Store |
• retail pickup • ship-for pickup if the Use OROB for Ship for Pickup Fulfillment Assignment (M34) system control value is set to NEVER or blank |
The order has been received by the store location but not yet picked up by the customer. |
Partial Fulfill |
• retail pickup • store pickup • ship-for-pickup if the Use OROB for Ship for Pickup Fulfillment Assignment (M34) system control value is set to NEVER or blank |
The customer has picked up one or more items on the order, but not the complete order. |
In order to avoid sending unnecessary status inquiry messages for orders in these statuses, the BROKER process checks their status once daily during a specified time window. It uses the following two additional properties in Working with Customer Properties (PROP) to determine the start and end of the window:
• OROB_LIMITED_STATUS_BEG_TIME=123456
• OROB_LIMITED_STATUS_END_TIME=123456
Each time is indicated in HHMMSS format, military time. For example, if you set these properties to:
OROB_LIMITED_STATUS_BEG_TIME=180000
OROB_LIMITED_STATUS_END_TIME=210000
Then the BROKER process can send status inquiry requests for these orders between 6:00 p.m. and 9:00 p.m. daily. Orders are eligible for status inquiry if one has not taken place in the previous 12 hours.
You should set the time window long enough to process status inquiries for all orders in the related statuses; also, the time window should not cross midnight.
Note: You use the Order Broker Status Update Interval (K10) system control value to define how many minutes Order Management System should wait before sending status inquiry requests for all other status updates.
Use the OROB_MESSAGE_VERSION property to specify the message version to include in Order Broker and merchandise locator request messages that Order Management System sends to Order Broker.
A message version of 5.0 or higher is required to use the status list request message and streamlined allocation at pick slip generation. See Use OROB Status Inquiry List Web Service (M05) and Use Streamlined Allocation (L63) for background.
A message version of 16.0 or higher is required to send delivery and ship-for-pickup orders to Order Broker for fulfillment assignment. See Brokered Backorders for background.
Important: To avoid unpredictable results, do not leave the OROB_MESSAGE_VERSION blank.
Use the OROB_IMPORTS_ENABLED property to define whether the system uses the Order Broker Import RESTful web service to automatically upload product, product location, and incremental inventory import files to the OROB-Imports location on the Order Broker application server.
• true = The system uses the Order Broker Import RESTful web service to automatically upload product, product location, and incremental inventory files to the OROB-Imports location in Order Broker. Note: Set this value to true only if you are use Oracle Retail Order Broker version 17.0 or higher.
• false = The system does not use the Order Broker Import RESTful web service to automatically upload product, product location, and incremental inventory files to Order Broker. Instead, the system places the generated file in the location on the application server defined in the OROB_DIRECTORY_PATH property and you must use sFTP to move the files to the OROB-Imports location in Order Broker.
Once the import file is in the OROB-Imports location in Order Broker, you must use the Schedule Import Process screen in Oracle Retail Order Broker to process the import. You can also run the import on demand from this screen.
See Order Broker’s Product, Product Location, and Incremental Inventory Import Process.
Use the OROB_DIRECTORY_PATH property to define the location on the application server where the system creates Order Broker product, product location, and incremental inventory files to import into Order Broker. An example directory is /domain/conf/OMSFiles/OROBData/, where domain is the WebLogic domain directory for Order Management System. Note: If the OROB_DIRECTORY_PATH is not valid or is blank, or the specified folder does not exist, the system does not create any output files and writes a message to the Application log.
See Order Broker’s Product, Product Location, and Incremental Inventory Import Process.
Use the OROB_IMPORTS_URL property to define the URL used to call the Order Broker Import RESTful web service when sending product, product location, and incremental inventory data to Order Broker and the OROB_IMPORTS_ENABLED property is set to true.
For example: https://order_broker_url:port, where order_broker_url is the URL used to connect to Order Broker and port if the port number used to connect to Order Broker.
Web service authentication: If the Import web service requires basic web service authentication, you must define a valid web service authentication user and password in Working with Web Service Authentication (WWSA).
See Order Broker’s Product, Product Location, and Incremental Inventory Import Process.
Additional Order Broker Setup in Order Management System
Purpose: Additional setup for integration with Order Broker is described below:
General Order Broker setup:
• Unselect the OROB eligible flag for any items that should not be included in the Order Broker integration. This flag is selected by default.
• Complete the Locate location for each warehouse that maps to a location in Order Broker. If the Send Inventory by Warehouse to OROB (L06) system control value is selected:
- the product import process sends inventory information separately for each warehouse that has a Locate location specified.
- the BROKER process sends a separate fulfillment request message for each warehouse that has a Locate location specified.
• A first and last name or a company name are required for the sold-to customer on all orders sent to Order Broker.
Order Broker setup:
• BROKER process in Working with Integration Layer Processes (IJCT):
- Set up any trigger rules for brokered backorders. The fields in the Item (INITEM) and SKU (INSKU) tables are available for trigger rule setup. Note: These trigger rules apply only if the Use OROB for Fulfillment Assignment (M31) system control value is unselected and the brokered backorder is not a ship-for-pickup order.
- Optionally, set the Outbound delay time. The Outbound delay time controls how often to send fulfillment request messages.
• Secured features:
- Use the Cancel Order Broker Lines (B19) secured feature to restrict access to Order Broker cancellations as needed.
- Use the Maintain Brokered Fulfillment Orders (B20) secured feature to restrict access to order maintenance for retail pickup or delivery orders.
• Store cross references: Create store location cross references for each potential fulfilling location through Work with Store Cross Reference (WSCR), including:
- optionally, specify a source code for any store location to send retail pickup or delivery orders to Order Management System as an override to the Order Broker Source Code (K93). If the fulfillment response message specifies a source code, it overrides any source code specified in the system control value or the store cross reference.
- for ship-for-pickup orders, select the Ship for pickup flag; also, complete the description and address fields, as this information is used as the ship-to name and address for ship-for-pickup orders.
- optionally, specify a System Code to override the Name in OROB for Point of Sale (L09) used to identify the fulfilling location for ship-for-pickup and store pickup orders. For example, if you use the Store Connect module for pickup orders in some store locations, but use a point-of-sale system for other locations that support ship-for-pickup orders, you might set this system control value to the code identifying your point-of-sale system, and enter the code for your Store Connect system for the Store Cross Reference records used for Store Connect locations. When submitting a store pickup or ship-for-pickup order to Order Broker, Order Management System uses the System Code, if any, from the Store Cross Reference record; otherwise, it uses the system code from this system control value.
Note: You can use the Importing Store Cross Reference Locations through Order Broker’s Discovery Web Service option to create store cross reference records.
• BROKER periodic function: Set up and schedule the BROKER periodic function (program PFR0083) to generate requests for existing backordered lines.
Note: Since the BROKER periodic function should not run at the same time as pick slip generation, the periodic function runs in the PICKGEN queue regardless of your selection for the periodic process.
• Schedule BROKER process: Optionally, set up periodic functions to schedule the BROKER process in Working with Integration Layer Processes (IJCT):
- ENDBROK (program=ILENDBROKR) to stop the BROKER process
- STRBROK (program=ILSTRBROKR) to start the BROKER process
• CWPickOut: If you use the CWPickOut message to send pick slip information from Order Management System to an external system, set the Outbound XML version of the PICK_OUT process in Working with Integration Layer Processes (IJCT) to 3.0 or higher to include:
- broker_delivery_type of R (retail pickup), D (delivery), or S (ship-for-pickup)
Note: This field is not used for brokered backorders.
- destination_store: the store cross-reference code (WSCR) for a ship-for-pickup order
- originating_store: the store cross-reference code (WSCR) for a retail pickup or delivery order
• CWInvoiceOut: If you use the CWInvoiceOut message to send invoice information to an external system, set the Outbound XML version of the INVOIC_OUT process in Working with Integration Layer Processes (IJCT) to 2.0 or higher to include:
- ost_broker_delivery_type of R (retail pickup), D (delivery), or S (ship-for-pickup)
Note: This field is not used for brokered backorders.
- ost_destination_store: the store cross-reference code (WSCR) for a ship-for-pickup order
- ost_originating_store: the store cross-reference code (WSCR) for a retail pickup or delivery order
• Email setup: Use the Email notification flag to control email generation for the retail pickup, delivery, or store pickup order types. Also, set up the store pickup notification template. See Email Generation Setup for more information.
• Merchandise locator setup: For merchandise locator searching: Make sure the MERCH_LOC process in Working with Integration Layer Processes (IJCT) has its Communication type field set to Web Service.
Notes on Configuration in Order Broker
Follow the steps described under Setting Up Data in Order Broker in the Order Broker online help or operations guide, using the following notes to configure the integration between Order Broker and Order Management System:
System setup:
• Default system? If Order Management System is the default system for your organization, set the OROB Product Code ID (K66) system control value in Order Management System to Item/SKU or blank. Otherwise, if Order Management System is not your default system, use the OROB Product Code (K66) system control value to indicate the field you use to store each item’s product code from the default system.
• Setting up the Order Management System system: Also, when creating the system for Order Management System in Order Broker, set the System code in Order Broker to match the Company number in Order Management System and the OROB System (K50) system control value. The code should not be zero-padded (that is, create a system of 2 rather than 002).
Warehouse (location) setup:
• If the Send Inventory by Warehouse to OROB (L06) system control is unselected, create a location in Order Broker to represent your default warehouse in Order Management System as defined in the OROB Default Location (K51). The location code in Order Broker should match the warehouse number in Order Management System, and should not be zero-padded (that is, create a warehouse of 1 rather than 0001).
• If the Send Inventory by Warehouse to OROB (L06) system control is selected, create a location in Order Broker for each warehouse that has an OROB location specified. The location code in Order Broker should match the warehouse number in Order Management System, and should not be zero-padded (that is, create a warehouse of 1 rather than 0001).
• If you have defined a location in the Originating Location to Pass to OROB (M32) system control value, create this location in Order Broker. The location code in Order Broker should match the warehouse number in Order Management System, and should not be zero-padded (that is, create a warehouse of 1 rather than 0001).
• At the Preferences screen in Order Broker, flag the default Order Management System location, and any additional locations representing Order Management System warehouses, as Pickup available = No. (NOTE: You can set this flag at the location type level if you have set up a location type to represent your Order Management System warehouses; in this case, you do not need to set the flag for each individual location.)
Note: See the Order Broker online help for additional steps to setting up data in Order Broker.
Product and inventory import setup: Use the System Import Schedule screen to set up a schedule for importing items and inventory information from Order Management System into Order Broker. When setting up the schedule:
• Select the Enabled flag.
• Select each day of the week when the process should run, or select Daily to run the process every day.
• Enter the time, in HH:MM:SS format (military time), when the process should run for all selected days.
• If Order Management System is your default system, make sure to schedule its import process about 30 minutes earlier than any other systems to prevent product import errors. The product import will fail if you attempt to create a system product record before the product record for the default system exists.
Note: Schedule the product and inventory import so that it occurs after the purchase order layering process completes. See Purchase Order Layering for more information.
| Vertex Setup | Contents | SCVs | Search | Glossary | Reports | Solutions | XML | Index | Generic Web Services |
Locate_Serenade config OROMS 17.0 2018 OTN